/*
 * Robust Pointers - A framework for robust pointers in a MT environment.
 * http://code.google.com/p/rptr/
 *
 * Copyright (c) 2009, Bill K. Barekas <bbarekas@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the author nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file    rptr_error.h
 * @author  Bill K. Barekas <bbarekas@gmail.com>
 * @date    October 10, 2009
 * @version $Id$
 *
 * This file contains the error codes declarations.
 */


#ifndef RPTR_ERROR_H_
#define RPTR_ERROR_H_


/**
 * rptr_errno
 *
 * Global RPTR last error returned.
 */
extern int          rptr_errno;


/**
 * rptr_error_e enumeration
 *
 * This enumeration is used to represent all the possible error codes
 * returned by RPTR calls.
 */
enum rptr_error_e {
  RPTR_OK                               = 0,
  RPTR_ERROR_COMMON                     = -1,
  RPTR_ERROR_INITIALIZED                = -2,
  RPTR_ERROR_NOT_INITIALIZED            = -3,
  RPTR_ERROR_INVALID_RPTR_TYPE          = -4,
  RPTR_ERROR_OBJ_NOT_ALLOCATED          = -5,
  /**
   * NOTE:
   * Add new values above this point.
   */
  RPTR_ERROR_MAX                        = 6
};
typedef enum rptr_error_e    rptr_error;


/**
 * Exported functions
 */

char * rptr_error_str(int error);


#endif /* RPTR_ERROR_H_ */
